home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / TICKER.HDR < prev    next >
Text File  |  1994-04-25  |  2KB  |  66 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _Ticker(nLine,nCol,nLength,cText,nDelay,lPause,cSepChar) --> NIL
  8.  
  9. PARAMETERS:
  10.  
  11. nLine   : Line on which to display
  12. nCol    : Column at which to begin display
  13. nLength : Length of display
  14. cText   : Text to display
  15. nDelay  : Delay between characters
  16. lPause  : Pause when Display Complete?
  17. cSepChar: Separator Character
  18.  
  19. SHORT:
  20.  
  21. A Times-Square'esque ticker tape display.
  22.  
  23. DESCRIPTION:
  24.  
  25. _Ticker() presents a "ticker-tape" type display of one line of text.  The
  26. text can be any length, but typically should be longer than the display
  27. width (it wouldn't look like a ticker-tape display if all the text could
  28. fit in the display line at once!).
  29.  
  30. The nLine and nCol define the line and left-most column of the line that
  31. will be used as the display area.  The nLength parameter determines how
  32. many characters wide the display will be.
  33.  
  34. Because some CPU's are much faster than others, fast CPU's may display the
  35. text so quickly that it cannot be read.  The nDelay parameter can be used to
  36. set a pause time between each of the characters in the text string.  This
  37. number's value will depend upon the type CPU being used.  Experiment to find
  38. a suitable value (typically starting at 300 - 400).
  39.  
  40. If lPause is TRUE, then the display pauses and waits for a keystroke before
  41. beginning the display over again.  If it is FALSE, the display runs non stop,
  42. from left to right.  (My apologies to my Chinese users :-)
  43.  
  44. cSepChar can be used to change the default separator character (a SPACE).
  45. You can change it to dots, for instance by passing '.' in this parameter.
  46.  
  47. NOTE:
  48.  
  49.  
  50.  
  51. EXAMPLE:
  52.  
  53. _Box(5,10,7,75) // set up a box for the display
  54.  
  55. String = 'This is an example of the function syntax for the '+ ;
  56.          'Function _Ticker().  It scolls from left to right '+ ;
  57.          'and fits within the box we just drew.'
  58.  
  59. _Ticker(6,11,63,String,200,'.')
  60.  
  61. Result: The text string displays on line 6 between positions 11 and 74, with
  62. a 200 count pause between each character and using a dot as the separator
  63. character.
  64.  
  65. ******************************************************************************/
  66.